adTempus API
PreviousUpNext
IADTObject::GetDescription Method

Gets a user-friendly description of the object.

C++
HRESULT GetDescription([out, retval] BSTR * pVal);
C#
GetDescription([out, retval] BSTR pVal);
Visual Basic
Sub GetDescription(pVal As [out, retval] BSTR)

A string that describes the object, suitable for identifying the object to a user in a user interface.

The GetDescription method can be used when you need to list or describe an object in a user interface. For example, in the adTempus Console, list boxes and combo-boxes that list objects use the GetDescription method to get the string to display.

adTempus API Reference version 3.0.0.0, revised 10/30/2008